Added tests for JobManager #263
Conversation
dwang3851
commented
Nov 10, 2024
dwang3851
commented
- Added test cases for JobManager
- Made slight changes to imports in tango.py to prevent circular import issues
dwang3851
requested review from
a team and
20wildmanj
and removed request for
a team
📝 WalkthroughWalkthroughThe changes introduce a new file, Changes
Sequence Diagram(s)sequenceDiagram
participant TM as Test Manager
participant JM as Job Manager
participant JQ as Job Queue
participant W as Worker
TM->>JM: test_start()
JM->>JM: set running = True
TM->>JM: test__getNextID()
JM->>JM: generate next job ID
TM->>JM: test_manage_worker_works()
JM->>JQ: assign job
JQ->>W: start job
W->>JM: job assigned successfully
TM->>JM: test_manage_worker_fails()
JM->>W: simulate job failure
W->>JM: job failed
JM->>JM: call makeDead()
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Outside diff range and nitpick comments (2)
tests/testJobManager.py (2)
25-76: Consider improving setUp documentation and error handling.The setUp method handles multiple VMMS configurations but could benefit from:
- Docstring explaining the setup process
- Better error handling for unsupported VMMS_NAME
Consider adding a docstring and improving error handling:
def setUp(self): + """Initialize test environment with appropriate VMMS configuration. + + Cleans Redis if enabled and sets up the appropriate Virtual Machine + Management System (VMMS) based on Config.VMMS_NAME. + """ if Config.USE_REDIS: __db = redis.StrictRedis(Config.REDIS_HOSTNAME, Config.REDIS_PORT, db=0) __db.flushall() if Config.VMMS_NAME == "ec2SSH": from vmms.ec2SSH import Ec2SSH vmms = Ec2SSH() self.preallocator = Preallocator({"ec2SSH": vmms}) elif Config.VMMS_NAME == "localDocker": from vmms.localDocker import LocalDocker vmms = LocalDocker() self.preallocator = Preallocator({"localDocker": vmms}) elif Config.VMMS_NAME == "distDocker": from vmms.distDocker import DistDocker vmms = DistDocker() self.preallocator = Preallocator({"distDocker": vmms}) else: - vmms = None - self.preallocator = Preallocator({"default": vmms}) + raise ValueError(f"Unsupported VMMS_NAME: {Config.VMMS_NAME}")🧰 Tools
🪛 Ruff
35-35:
Preallocatormay be undefined, or defined from star imports(F405)
41-41:
Preallocatormay be undefined, or defined from star imports(F405)
47-47:
Preallocatormay be undefined, or defined from star imports(F405)
50-50:
Preallocatormay be undefined, or defined from star imports(F405)
77-80: Add assertions for JobManager state.The test_start method could be more comprehensive by verifying additional JobManager state.
Consider adding more assertions:
def test_start(self): self.jobManager.start() self.assertTrue(self.jobManager.running) + self.assertIsNotNone(self.jobManager.vmms) + self.assertEqual(self.jobManager.nextId, 1)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
tests/testJobManager.py(1 hunks)
🧰 Additional context used
🪛 Ruff
tests/testJobManager.py
9-9: from preallocator import * used; unable to detect undefined names
(F403)
13-13: Do not use mutable data structures for argument defaults
Replace with None; initialize within function
(B006)
35-35: Preallocator may be undefined, or defined from star imports
(F405)
41-41: Preallocator may be undefined, or defined from star imports
(F405)
47-47: Preallocator may be undefined, or defined from star imports
(F405)
50-50: Preallocator may be undefined, or defined from star imports
(F405)
90-90: time may be undefined, or defined from star imports
(F405)
110-110: time may be undefined, or defined from star imports
(F405)
115-115: time may be undefined, or defined from star imports
(F405)
137-137: time may be undefined, or defined from star imports
(F405)
| def test_manage_worker_works(self): | ||
| def mock_getNextPendingJob(): | ||
| time.sleep(0.2) | ||
| self.job1.setId(1) | ||
| return self.job1 | ||
|
|
||
| def mock_reuseVM(job): | ||
| job.assigned = True | ||
| job.vm = self.vm | ||
| self.preallocator.vmms[job.vm.vmms] = self.jobManager.vmms | ||
| return self.vm | ||
|
|
||
| def mock_worker_init(job, vmms, jobQueue, preallocator, preVM): | ||
| pass | ||
|
|
||
| self.jobQueue.assignJob = MagicMock() | ||
| with patch( | ||
| "jobQueue.JobQueue.getNextPendingJob", side_effect=mock_getNextPendingJob | ||
| ), patch("jobQueue.JobQueue.reuseVM", side_effect=mock_reuseVM), patch( | ||
| "worker.Worker.__init__", side_effect=mock_worker_init | ||
| ): | ||
| self.jobManager.start() | ||
| time.sleep(2) | ||
| self.jobQueue.assignJob.assert_called() | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Improve reliability of worker tests.
The worker tests have several potential issues:
- Hard-coded sleep times can make tests flaky
- Missing cleanup in tearDown
- Limited assertion coverage
Consider these improvements:
- Use event-based synchronization instead of sleep
- Add proper cleanup
- Add more assertions for job state
Example implementation:
def test_manage_worker_works(self):
job_ready = threading.Event()
def mock_getNextPendingJob():
job_ready.wait(timeout=1) # More reliable than sleep
self.job1.setId(1)
return self.job1
# ... rest of the test ...
self.jobManager.start()
job_ready.set() # Signal that job is ready
self.jobQueue.assignJob.assert_called_with(self.job1)
self.assertTrue(self.job1.assigned)
self.assertEqual(self.job1.vm, self.vm)Would you like me to provide a complete implementation with these improvements?
Also applies to: 113-139
🧰 Tools
🪛 Ruff
90-90: time may be undefined, or defined from star imports
(F405)
110-110: time may be undefined, or defined from star imports
(F405)
| elif Config.VMMS_NAME == "distDocker": | ||
| from vmms.distDocker import DistDocker | ||
|
|
||
| vmms = DistDocker() | ||
| self.preallocator = Preallocator({"distDocker": vmms}) | ||
| else: | ||
| vmms = None | ||
| self.preallocator = Preallocator({"default": vmms}) | ||
|
|
||
| self.job1 = TangoJob( | ||
| name="sample_job_1", | ||
| vm="ilter.img", | ||
| outputFile="sample_job_1_output", | ||
| input=[], | ||
| timeout=30, | ||
| notifyURL="notifyMeUrl", | ||
| maxOutputFileSize=4096, | ||
| ) | ||
|
|
||
| self.job2 = TangoJob( | ||
| name="sample_job_2", | ||
| vm="ilter.img", | ||
| outputFile="sample_job_2_output", | ||
| input=[], | ||
| timeout=30, | ||
| notifyURL="notifyMeUrl", | ||
| maxOutputFileSize=4096, | ||
| ) | ||
|
|
||
| self.jobQueue = JobQueue(self.preallocator) | ||
| self.jobQueue.reset() | ||
| self.jobManager = JobManager(self.jobQueue) | ||
| self.vm = self.createTangoMachine(image="autograding_image", vmms=vmms) | ||
|
|
||
| def test_start(self): | ||
| self.jobManager.start() | ||
| self.assertTrue(self.jobManager.running) | ||
|
|
||
| def test__getNextID(self): | ||
| init_id = self.jobManager.nextId | ||
| for i in range(1, Config.MAX_JOBID + 100): | ||
| id = self.jobManager._getNextID() | ||
| self.assertEqual(init_id + i - 1, id) | ||
| self.jobManager.nextId = init_id | ||
|
|
||
| def test_manage_worker_works(self): | ||
| def mock_getNextPendingJob(): | ||
| time.sleep(0.2) | ||
| self.job1.setId(1) | ||
| return self.job1 | ||
|
|
||
| def mock_reuseVM(job): | ||
| job.assigned = True | ||
| job.vm = self.vm | ||
| self.preallocator.vmms[job.vm.vmms] = self.jobManager.vmms | ||
| return self.vm | ||
|
|
||
| def mock_worker_init(job, vmms, jobQueue, preallocator, preVM): | ||
| pass | ||
|
|
||
| self.jobQueue.assignJob = MagicMock() | ||
| with patch( | ||
| "jobQueue.JobQueue.getNextPendingJob", side_effect=mock_getNextPendingJob | ||
| ), patch("jobQueue.JobQueue.reuseVM", side_effect=mock_reuseVM), patch( | ||
| "worker.Worker.__init__", side_effect=mock_worker_init | ||
| ): | ||
| self.jobManager.start() | ||
| time.sleep(2) | ||
| self.jobQueue.assignJob.assert_called() | ||
|
|
||
| def test_manage_worker_fails(self): | ||
| def mock_getNextPendingJob(): | ||
| time.sleep(2) | ||
| self.job1.setId(1) | ||
| return self.job1 | ||
|
|
||
| def mock_reuseVM(job): | ||
| job.assigned = True | ||
| job.vm = self.vm | ||
| self.preallocator.vmms[job.vm.vmms] = self.jobManager.vmms | ||
| return self.vm | ||
|
|
||
| def mock_worker_init(job, vmms, jobQueue, preallocator, preVM): | ||
| raise RuntimeError("Job failed") | ||
|
|
||
| self.jobQueue.assignJob = MagicMock() | ||
| self.jobQueue.makeDead = MagicMock() | ||
|
|
||
| with patch( | ||
| "jobQueue.JobQueue.getNextPendingJob", side_effect=mock_getNextPendingJob | ||
| ), patch("jobQueue.JobQueue.reuseVM", side_effect=mock_reuseVM), patch( | ||
| "worker.Worker.__init__", side_effect=mock_worker_init | ||
| ): | ||
| self.jobManager.start() | ||
| time.sleep(4) | ||
| self.jobQueue.makeDead.assert_called_once() | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| unittest.main() |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add missing test cases for comprehensive coverage.
The current test suite is missing several important test cases:
- Error handling for invalid job configurations
- Concurrent job processing
- Job timeout scenarios
- Resource cleanup
Would you like me to help generate additional test cases to improve coverage?
🧰 Tools
🪛 Ruff
9-9: from preallocator import * used; unable to detect undefined names
(F403)
13-13: Do not use mutable data structures for argument defaults
Replace with None; initialize within function
(B006)
35-35: Preallocator may be undefined, or defined from star imports
(F405)
41-41: Preallocator may be undefined, or defined from star imports
(F405)
47-47: Preallocator may be undefined, or defined from star imports
(F405)
50-50: Preallocator may be undefined, or defined from star imports
(F405)
90-90: time may be undefined, or defined from star imports
(F405)
110-110: time may be undefined, or defined from star imports
(F405)
115-115: time may be undefined, or defined from star imports
(F405)
137-137: time may be undefined, or defined from star imports
(F405)
| import unittest | ||
| import redis | ||
| from mock import MagicMock, patch | ||
|
|
||
| from jobManager import JobManager | ||
| from jobQueue import JobQueue | ||
| from tangoObjects import TangoJob, TangoMachine | ||
| from config import Config | ||
| from preallocator import * | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix import statements for better maintainability and reliability.
- Replace the wildcard import with explicit imports from preallocator
- Add missing time module import which is used in test methods
Apply this diff:
import unittest
import redis
+ import time
from mock import MagicMock, patch
from jobManager import JobManager
from jobQueue import JobQueue
from tangoObjects import TangoJob, TangoMachine
from config import Config
-from preallocator import *
+from preallocator import Preallocator📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| import unittest | |
| import redis | |
| from mock import MagicMock, patch | |
| from jobManager import JobManager | |
| from jobQueue import JobQueue | |
| from tangoObjects import TangoJob, TangoMachine | |
| from config import Config | |
| from preallocator import * | |
| import unittest | |
| import redis | |
| import time | |
| from mock import MagicMock, patch | |
| from jobManager import JobManager | |
| from jobQueue import JobQueue | |
| from tangoObjects import TangoJob, TangoMachine | |
| from config import Config | |
| from preallocator import Preallocator |
🧰 Tools
🪛 Ruff
9-9: from preallocator import * used; unable to detect undefined names
(F403)
| def createTangoMachine(self, image, vmms, vmObj={"cores": 1, "memory": 512}): | ||
| """createTangoMachine - Creates a tango machine object from image""" | ||
| return TangoMachine( | ||
| name=image, | ||
| vmms=vmms, | ||
| image="%s" % (image), | ||
| cores=vmObj["cores"], | ||
| memory=vmObj["memory"], | ||
| disk=None, | ||
| network=None, | ||
| ) | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix mutable default argument in createTangoMachine method.
Using mutable default arguments in Python can lead to unexpected behavior if the default value is modified.
Apply this diff:
- def createTangoMachine(self, image, vmms, vmObj={"cores": 1, "memory": 512}):
+ def createTangoMachine(self, image, vmms, vmObj=None):
"""createTangoMachine - Creates a tango machine object from image"""
+ if vmObj is None:
+ vmObj = {"cores": 1, "memory": 512}
return TangoMachine(
name=image,
vmms=vmms,
image="%s" % (image),
cores=vmObj["cores"],
memory=vmObj["memory"],
disk=None,
network=None,
)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| def createTangoMachine(self, image, vmms, vmObj={"cores": 1, "memory": 512}): | |
| """createTangoMachine - Creates a tango machine object from image""" | |
| return TangoMachine( | |
| name=image, | |
| vmms=vmms, | |
| image="%s" % (image), | |
| cores=vmObj["cores"], | |
| memory=vmObj["memory"], | |
| disk=None, | |
| network=None, | |
| ) | |
| def createTangoMachine(self, image, vmms, vmObj=None): | |
| """createTangoMachine - Creates a tango machine object from image""" | |
| if vmObj is None: | |
| vmObj = {"cores": 1, "memory": 512} | |
| return TangoMachine( | |
| name=image, | |
| vmms=vmms, | |
| image="%s" % (image), | |
| cores=vmObj["cores"], | |
| memory=vmObj["memory"], | |
| disk=None, | |
| network=None, | |
| ) |
🧰 Tools
🪛 Ruff
13-13: Do not use mutable data structures for argument defaults
Replace with None; initialize within function
(B006)
